/* SPDX-License-Identifier: GPL-2.0 */
/* Rewritten and vastly simplified by Rusty Russell for in-kernel
 * module loader:
 *   Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
 */
#ifndef _SEMINIX_KALLSYMS_H
#define _SEMINIX_KALLSYMS_H

#include <seminix/errno.h>
#include <seminix/kernel.h>
#include <seminix/stddef.h>
#include <asm/sections.h>

/* Chosen so that structs with an unsigned long line up. */
#define MAX_PARAM_PREFIX_LEN (64 - sizeof(unsigned long))
#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN

#define KSYM_NAME_LEN 128
#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \
             2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1)

static inline int is_kernel_inittext(unsigned long addr)
{
    if (addr >= (unsigned long)_sinittext
        && addr <= (unsigned long)_einittext)
        return 1;
    return 0;
}

static inline int is_kernel_text(unsigned long addr)
{
    if ((addr >= (unsigned long)_stext && addr <= (unsigned long)_etext) ||
        arch_is_kernel_text(addr))
        return 1;
    return 0;
}

static inline int is_kernel(unsigned long addr)
{
    if (addr >= (unsigned long)_stext && addr <= (unsigned long)_end)
        return 1;
    return 0;
}

static inline int is_ksym_addr(unsigned long addr)
{
    if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
        return is_kernel(addr);

    return is_kernel_text(addr) || is_kernel_inittext(addr);
}

static inline void *dereference_symbol_descriptor(void *ptr)
{
#ifdef HAVE_DEREFERENCE_FUNCTION_DESCRIPTOR
    ptr = dereference_kernel_function_descriptor(ptr);
    if (is_ksym_addr((unsigned long)ptr))
        return ptr;
#endif
    return ptr;
}

#ifdef CONFIG_KALLSYMS
/* Lookup the address for a symbol. Returns 0 if not found. */
unsigned long kallsyms_lookup_name(const char *name);

/* Call a function on each kallsyms symbol in the core kernel */
int kallsyms_on_each_symbol(int (*fn)(void *, const char *, unsigned long), void *data);

extern int kallsyms_lookup_size_offset(unsigned long addr,
                  unsigned long *symbolsize,
                  unsigned long *offset);

/* Lookup an address.  modname is set to NULL if it's in the kernel. */
const char *kallsyms_lookup(unsigned long addr,
                unsigned long *symbolsize,
                unsigned long *offset,
                char **modname, char *namebuf);

/* Look up a kernel symbol and return it in a text buffer. */
extern int sprint_symbol(char *buffer, unsigned long address);
extern int sprint_symbol_no_offset(char *buffer, unsigned long address);
extern int sprint_backtrace(char *buffer, unsigned long address);

int lookup_symbol_name(unsigned long addr, char *symname);
int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);

/* How and when do we show kallsyms values? */
extern int kallsyms_show_value(void);

#else /* !CONFIG_KALLSYMS */

static inline unsigned long kallsyms_lookup_name(const char *name)
{
    return 0;
}

static inline int kallsyms_on_each_symbol(int (*fn)(void *, const char *,
                    unsigned long), void *data)
{
    return 0;
}

static inline int kallsyms_lookup_size_offset(unsigned long addr,
                          unsigned long *symbolsize,
                          unsigned long *offset)
{
    return 0;
}

static inline const char *kallsyms_lookup(unsigned long addr,
                      unsigned long *symbolsize,
                      unsigned long *offset,
                      char **modname, char *namebuf)
{
    return NULL;
}

static inline int sprint_symbol(char *buffer, unsigned long addr)
{
    *buffer = '\0';
    return 0;
}

static inline int sprint_symbol_no_offset(char *buffer, unsigned long addr)
{
    *buffer = '\0';
    return 0;
}

static inline int sprint_backtrace(char *buffer, unsigned long addr)
{
    *buffer = '\0';
    return 0;
}

static inline int lookup_symbol_name(unsigned long addr, char *symname)
{
    return -ERANGE;
}

static inline int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
{
    return -ERANGE;
}

static inline int kallsyms_show_value(void)
{
    return false;
}

#endif /*CONFIG_KALLSYMS*/

static inline void print_ip_sym(unsigned long ip)
{
    printk("[<%px>] %pS\n", (void *) ip, (void *) ip);
}

#endif /* !_SEMINIX_KALLSYMS_H */
